/*
* Copyright (c) 2007, Nubo Technologies
* 
* All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*
*    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
*    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
*    * Neither the name of the Nubo Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.nubotech.gwt.oss.client;

import java.util.HashMap;
import java.util.Map;

/**
 * 
 * The Grantee of a Group can either be a User or a Group.
 * @author jonnakkerud
 */
public abstract class Grantee {
    public static final String CANONICAL_USER = "CanonicalUser";
    public static final String GROUP = "Group";
    
    // A user that has an email address that individual uses to log into their Amazon.com retail web site account
    public static final String EMAIL_USER = "AmazonCustomerByEmail";
        
    private String type;
    private Map properties;

    
    public static Grantee createGrantee(String type) {
        if (CANONICAL_USER.equals(type)) {
            return new CanonicalUser();
            
        }
        else if (GROUP.equals(type)) {
            return new Group();
            
        }
        else if (EMAIL_USER.equals(type)) {
            return new EmailUser();
            
        }
        return null;
    }
        
    /**
     * Return the type of Grantee. Can be a Group, CanonicalUser or AmazonCustomerByEmail
     * @return The Grantee type
     */
    public String getType() {
        return type;
    }

    /**
     * Set the Grantee type: CanonicalUser, Group or AmazonCustomerByEmail.
     * @param type The type of Grantee
     */
    protected void setType(String type) {
        this.type = type;
    }

    /**
     * Return the propeties associated with the Grantee
     * @return Return the Grantee properties
     */
    public Map getProperties() {
        if (properties == null) {
            properties = new HashMap();
        }
        return properties;
    }
    
}
